home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / perl5 / ExtUtils::Mksymlists.z / ExtUtils::Mksymlists
Encoding:
Text File  |  1998-10-30  |  5.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMkkkkssssyyyymmmmlllliiiissssttttssss((((3333))))                                EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMkkkkssssyyyymmmmlllliiiissssttttssss((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ExtUtils::Mksymlists - write linker options files for dynamic extension
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.          use ExtUtils::Mksymlists;
  13.          Mksymlists({ NAME     => $name ,
  14.                       DL_VARS  => [ $var1, $var2, $var3 ],
  15.                       DL_FUNCS => { $pkg1 => [ $func1, $func2 ],
  16.                                     $pkg2 => [ $func3 ] });
  17.  
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      ExtUtils::Mksymlists produces files used by the linker under some OSs
  21.      during the creation of shared libraries for dynamic extensions.  It is
  22.      normally called from a MakeMaker-generated Makefile when the extension is
  23.      built.  The linker option file is generated by calling the function
  24.      Mksymlists, which is exported by default from ExtUtils::Mksymlists.  It
  25.      takes one argument, a list of key-value pairs, in which the following
  26.      keys are recognized:
  27.  
  28.      NAME This gives the name of the extension (_e._g. Tk::Canvas) for which the
  29.           linker option file will be produced.
  30.  
  31.      DL_FUNCS
  32.           This is identical to the DL_FUNCS attribute available via MakeMaker,
  33.           from which it is usually taken.  Its value is a reference to an
  34.           associative array, in which each key is the name of a package, and
  35.           each value is an a reference to an array of function names which
  36.           should be exported by the extension.  For instance, one might say
  37.           DL_FUNCS => { Homer::Iliad   => [ _q_w(trojans greeks) ],
  38.           Homer::Odyssey => [ _q_w(travellers family suitors) ] }.  The function
  39.           names should be identical to those in the XSUB code; Mksymlists will
  40.           alter the names written to the linker option file to match the
  41.           changes made by _x_s_u_b_p_p.  In addition, if none of the functions in a
  42.           list begin with the string bbbbooooooootttt____, Mksymlists will add a bootstrap
  43.           function for that package, just as xsubpp does.  (If a bbbbooooooootttt____<<<<ppppkkkkgggg>>>>
  44.           function is present in the list, it is passed through unchanged.)
  45.           If DL_FUNCS is not specified, it defaults to the bootstrap function
  46.           for the extension specified in NAME.
  47.  
  48.      DL_VARS
  49.           This is identical to the DL_VARS attribute available via MakeMaker,
  50.           and, like DL_FUNCS, it is usually specified via MakeMaker.  Its
  51.           value is a reference to an array of variable names which should be
  52.           exported by the extension.
  53.  
  54.      FILE This key can be used to specify the name of the linker option file
  55.           (minus the OS-specific extension), if for some reason you do not
  56.           want to use the default value, which is the last word of the NAME
  57.           attribute (_e._g. for Tk::Canvas, FILE defaults to 'Canvas').
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMkkkkssssyyyymmmmlllliiiissssttttssss((((3333))))                                EEEExxxxttttUUUUttttiiiillllssss::::::::MMMMkkkkssssyyyymmmmlllliiiissssttttssss((((3333))))
  71.  
  72.  
  73.  
  74.      FUNCLIST
  75.           This provides an alternate means to specify function names to be
  76.           exported from the extension.  Its value is a reference to an array
  77.           of function names to be exported by the extension.  These names are
  78.           passed through unaltered to the linker options file.
  79.  
  80.      DLBASE
  81.           This item specifies the name by which the linker knows the
  82.           extension, which may be different from the name of the extension
  83.           itself (for instance, some linkers add an '_' to the name of the
  84.           extension).  If it is not specified, it is derived from the NAME
  85.           attribute.  It is presently used only by OS2.
  86.  
  87.      When calling Mksymlists, one should always specify the NAME attribute.
  88.      In most cases, this is all that's necessary.  In the case of unusual
  89.      extensions, however, the other attributes can be used to provide
  90.      additional information to the linker.
  91.  
  92. AAAAUUUUTTTTHHHHOOOORRRR
  93.      Charles Bailey <_b_a_i_l_e_y@_g_e_n_e_t_i_c_s._u_p_e_n_n._e_d_u>
  94.  
  95. RRRREEEEVVVVIIIISSSSIIIIOOOONNNN
  96.      Last revised 14-Feb-1996, for Perl 5.002.
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.